fix(reusePaths): dont reuse id if referenced in href #1784

SethFalco · 2023-09-18T19:40:10Z

Fixes a bug where the reusePaths plugin would reuse the node ID that it's optimizing, but that ID was also referenced in a href elsewhere in the document, so it unintentionally applied the path to other nodes.

Example

<svg xmlns="http://www.w3.org/2000/svg"
  xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="-29.947 60.987 69.975 102.505">
  <g transform="translate(-59 64)">
    <g id="b">
      <path id="a" fill="#000" d="M0 0v1h.5Z" transform="rotate(18 3.157 -.5)"/>
      <use xlink:href="#a" width="1" height="1" transform="scale(-1 1)"/>
    </g>
    <use xlink:href="#b" width="1" height="1" transform="rotate(72)"/>
    <use xlink:href="#b" width="1" height="1" transform="rotate(-72)"/>
    <use xlink:href="#b" width="1" height="1" transform="rotate(144)"/>
    <use xlink:href="#b" width="1" height="1" transform="rotate(-144)"/>
  </g>
  <path id="c" fill="#000" d="M0 0v1h.5Z" transform="rotate(18 3.157 -.5)"/>
  <use xlink:href="#c" width="1" height="1" transform="scale(-1 1)"/>
</svg>

In this document, svg g g path#a and svg path#c both have a reusable path. Before, since the first path has an ID, the behavior was that it would take and reuse that.

But that's not ideal in this case, because svg g g use[xlink:href] is referencing #a already. By making that change, it changed what that node was referencing to an entirely different path.

This PR checks if the ID is already being referenced by another node. If so, create a new ID anyway instead of reusing and deleting the existing one.

Notes

When set as a default plugin, test-regression had 3 mismatches before, still at 3.

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [svgo](https://svgo.dev) ([source](https://togithub.com/svg/svgo)) | [`3.0.2` -> `3.0.3`](https://renovatebot.com/diffs/npm/svgo/3.0.2/3.0.3) | [![age](https://developer.mend.io/api/mc/badges/age/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>svg/svgo (svgo)</summary> ### [`v3.0.3`](https://togithub.com/svg/svgo/releases/tag/v3.0.3) [Compare Source](https://togithub.com/svg/svgo/compare/v3.0.2...v3.0.3) Includes various bug fixes and optimizations for existing plugins. We're also revamped the documentation for the project. You can find it on [svgo.dev](https://svgo.dev/)! The frontend for svgo.dev is maintained in [svg/svgo.dev](https://togithub.com/svg/svgo.dev), contributions are welcome. #### What's Changed ##### Settings - **Remove Comments**, introduces `preservePatterns` parameter. Preserves legal comments by default, same as the previous behavior, but can now be overridden. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1812](https://togithub.com/svg/svgo/pull/1812) - **Remove Description**, set the `removeAny` parameter to `false` by default for accessibility. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1806](https://togithub.com/svg/svgo/pull/1806) ##### Bug Fixes - **Remove Raster Images**, removes inlined JPEG images. By [@abejfehr](https://togithub.com/abejfehr) in [https://github.com/svg/svgo/pull/1742](https://togithub.com/svg/svgo/pull/1742) - **Cleanup IDs**, correctly handle when 2 IDs have been referenced in a single attribute. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1795](https://togithub.com/svg/svgo/pull/1795) - **Cleanup IDS**, correctly handle when we've encountered a reference to a node that doesn't exist. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1817](https://togithub.com/svg/svgo/pull/1817) - **Inline Styles**, treat style prop keys as case-insensitive. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1797](https://togithub.com/svg/svgo/pull/1797) - **Inline Styles**, remove all classes in multiclass selector. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1801](https://togithub.com/svg/svgo/pull/1801) - **Inline Styles**, ignore empty CSS blocks instead of adding empty style attribute. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1823](https://togithub.com/svg/svgo/pull/1823) - **Minify Styles**, removes unused class selectors when the document has no classes. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1800](https://togithub.com/svg/svgo/pull/1800) - **Prefix IDs**, reuse the same prefix when encountering an ID multiple times. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1814](https://togithub.com/svg/svgo/pull/1814) - **Remove Hidden Elements**, stops removing non-rendering elements like masks. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1793](https://togithub.com/svg/svgo/pull/1793) - **Reuse Paths**, creates a new ID if the current one is referenced by another element. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1784](https://togithub.com/svg/svgo/pull/1784) - **Reuse Paths**, removes redundant `defs` children after optimization. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1785](https://togithub.com/svg/svgo/pull/1785) - **Reuse Paths**, stops duplicating attributes into the shared definition. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1791](https://togithub.com/svg/svgo/pull/1791) - Don't crash on a `null`, `undefined`, or empty plugin. Instead, log a warning and ignore it. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/issues/1128](https://togithub.com/svg/svgo/issues/1128) ##### SVG Optimization - **Convert Transform**, omit spaces between functions. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1802](https://togithub.com/svg/svgo/pull/1802) - **Remove Scripts**, removes callbacks (`on*`) and `href` attributes with `javascript:` URIs. By [@cakeinpanic](https://togithub.com/cakeinpanic) and [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1807](https://togithub.com/svg/svgo/pull/1807), [https://github.com/svg/svgo/pull/1818](https://togithub.com/svg/svgo/pull/1818), [https://github.com/svg/svgo/pull/1819](https://togithub.com/svg/svgo/pull/1819), [https://github.com/svg/svgo/pull/1820](https://togithub.com/svg/svgo/pull/1820) - **Convert One-Stop Gradients**, new plugin to convert gradients with one stop to a solid color, disabled by default. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1790](https://togithub.com/svg/svgo/pull/1790) ##### Performance - Various optimizations for path handling. By [@marvinhagemeister](https://togithub.com/marvinhagemeister) in [https://github.com/svg/svgo/pull/1716](https://togithub.com/svg/svgo/pull/1716) and [https://github.com/svg/svgo/pull/1717](https://togithub.com/svg/svgo/pull/1717) ##### Chores - Revise the README. By [@ADTC](https://togithub.com/ADTC) in [https://github.com/svg/svgo/pull/1731](https://togithub.com/svg/svgo/pull/1731) - Fix dead link to postcss-svgo in README. By [@Lehoczky](https://togithub.com/Lehoczky) in [https://github.com/svg/svgo/pull/1770](https://togithub.com/svg/svgo/pull/1770) - Replace webpack loader library in README as previous was deprecated. By [@tanyabouman](https://togithub.com/tanyabouman) in [https://github.com/svg/svgo/pull/1771](https://togithub.com/svg/svgo/pull/1771) #### Metrics Before and after using vectors from various sources, with the default preset of each respective version: | SVG | Original | v3.0.2 | v3.0.3 | Delta | |---|---|---|---|---| | [Arch Linux Logo](https://archlinux.org/art/) | 8.584 KiB | 4.748 KiB | 4.747 KiB | ⬇️ 0.001 KiB | | [Blobs](https://gitlab.gnome.org/GNOME/gnome-backgrounds/-/blob/main/backgrounds/blobs-d.svg) | 50.45 KiB | 42.949 KiB | 42.949 KiB | | | [Isometric Madness](https://inkscape.org/~Denis_Kuznetsky/%E2%98%85isometric-madness) | 869.034 KiB | 550.829 KiB | 550.699 KiB | ⬇️ 0.13 KiB | | [tldr-pages Banner](https://togithub.com/tldr-pages/tldr/blob/main/images/banner.svg) | 2.071 KiB | 1.07 KiB | 1.07 KiB | | | [Wikipedia Logo](https://en.wikipedia.org/wiki/File:Wikipedia-logo-v2.svg) | 161.552 KiB | 118.441 KiB | 118.441 KiB | | Before and after of the browser bundle of each respective version: | | v3.0.2 | v3.0.3 | Delta | |---|---|---|---| | svgo.browser.js | 643.5 kB | 651.7 kB | ⬆️ 8.2 kB | </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 6am on Monday" in timezone Europe/Paris, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/cozy/cozy-stack).

[![Mend Renovate logo banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [svgo](https://svgo.dev) ([source](https://togithub.com/svg/svgo)) | [`3.0.2` -> `3.0.3`](https://renovatebot.com/diffs/npm/svgo/3.0.2/3.0.3) | [![age](https://developer.mend.io/api/mc/badges/age/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>svg/svgo (svgo)</summary> ### [`v3.0.3`](https://togithub.com/svg/svgo/releases/tag/v3.0.3) [Compare Source](https://togithub.com/svg/svgo/compare/v3.0.2...v3.0.3) Includes various bug fixes and optimizations for existing plugins. We're also revamped the documentation for the project. You can find it on [svgo.dev](https://svgo.dev/)! The frontend for svgo.dev is maintained in [svg/svgo.dev](https://togithub.com/svg/svgo.dev), contributions are welcome. #### What's Changed ##### Settings - **Remove Comments**, introduces `preservePatterns` parameter. Preserves legal comments by default, same as the previous behavior, but can now be overridden. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1812](https://togithub.com/svg/svgo/pull/1812) - **Remove Description**, set the `removeAny` parameter to `false` by default for accessibility. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1806](https://togithub.com/svg/svgo/pull/1806) ##### Bug Fixes - **Remove Raster Images**, removes inlined JPEG images. By [@abejfehr](https://togithub.com/abejfehr) in [https://github.com/svg/svgo/pull/1742](https://togithub.com/svg/svgo/pull/1742) - **Cleanup IDs**, correctly handle when 2 IDs have been referenced in a single attribute. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1795](https://togithub.com/svg/svgo/pull/1795) - **Cleanup IDS**, correctly handle when we've encountered a reference to a node that doesn't exist. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1817](https://togithub.com/svg/svgo/pull/1817) - **Inline Styles**, treat style prop keys as case-insensitive. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1797](https://togithub.com/svg/svgo/pull/1797) - **Inline Styles**, remove all classes in multiclass selector. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1801](https://togithub.com/svg/svgo/pull/1801) - **Inline Styles**, ignore empty CSS blocks instead of adding empty style attribute. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1823](https://togithub.com/svg/svgo/pull/1823) - **Minify Styles**, removes unused class selectors when the document has no classes. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1800](https://togithub.com/svg/svgo/pull/1800) - **Prefix IDs**, reuse the same prefix when encountering an ID multiple times. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1814](https://togithub.com/svg/svgo/pull/1814) - **Remove Hidden Elements**, stops removing non-rendering elements like masks. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1793](https://togithub.com/svg/svgo/pull/1793) - **Reuse Paths**, creates a new ID if the current one is referenced by another element. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1784](https://togithub.com/svg/svgo/pull/1784) - **Reuse Paths**, removes redundant `defs` children after optimization. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1785](https://togithub.com/svg/svgo/pull/1785) - **Reuse Paths**, stops duplicating attributes into the shared definition. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1791](https://togithub.com/svg/svgo/pull/1791) - Don't crash on a `null`, `undefined`, or empty plugin. Instead, log a warning and ignore it. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/issues/1128](https://togithub.com/svg/svgo/issues/1128) ##### SVG Optimization - **Convert Transform**, omit spaces between functions. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1802](https://togithub.com/svg/svgo/pull/1802) - **Remove Scripts**, removes callbacks (`on*`) and `href` attributes with `javascript:` URIs. By [@cakeinpanic](https://togithub.com/cakeinpanic) and [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1807](https://togithub.com/svg/svgo/pull/1807), [https://github.com/svg/svgo/pull/1818](https://togithub.com/svg/svgo/pull/1818), [https://github.com/svg/svgo/pull/1819](https://togithub.com/svg/svgo/pull/1819), [https://github.com/svg/svgo/pull/1820](https://togithub.com/svg/svgo/pull/1820) - **Convert One-Stop Gradients**, new plugin to convert gradients with one stop to a solid color, disabled by default. By [@SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1790](https://togithub.com/svg/svgo/pull/1790) ##### Performance - Various optimizations for path handling. By [@marvinhagemeister](https://togithub.com/marvinhagemeister) in [https://github.com/svg/svgo/pull/1716](https://togithub.com/svg/svgo/pull/1716) and [https://github.com/svg/svgo/pull/1717](https://togithub.com/svg/svgo/pull/1717) ##### Chores - Revise the README. By [@ADTC](https://togithub.com/ADTC) in [https://github.com/svg/svgo/pull/1731](https://togithub.com/svg/svgo/pull/1731) - Fix dead link to postcss-svgo in README. By [@Lehoczky](https://togithub.com/Lehoczky) in [https://github.com/svg/svgo/pull/1770](https://togithub.com/svg/svgo/pull/1770) - Replace webpack loader library in README as previous was deprecated. By [@tanyabouman](https://togithub.com/tanyabouman) in [https://github.com/svg/svgo/pull/1771](https://togithub.com/svg/svgo/pull/1771) #### Metrics Before and after using vectors from various sources, with the default preset of each respective version: | SVG | Original | v3.0.2 | v3.0.3 | Delta | |---|---|---|---|---| | [Arch Linux Logo](https://archlinux.org/art/) | 8.584 KiB | 4.748 KiB | 4.747 KiB | ⬇️ 0.001 KiB | | [Blobs](https://gitlab.gnome.org/GNOME/gnome-backgrounds/-/blob/main/backgrounds/blobs-d.svg) | 50.45 KiB | 42.949 KiB | 42.949 KiB | | | [Isometric Madness](https://inkscape.org/~Denis_Kuznetsky/%E2%98%85isometric-madness) | 869.034 KiB | 550.829 KiB | 550.699 KiB | ⬇️ 0.13 KiB | | [tldr-pages Banner](https://togithub.com/tldr-pages/tldr/blob/main/images/banner.svg) | 2.071 KiB | 1.07 KiB | 1.07 KiB | | | [Wikipedia Logo](https://en.wikipedia.org/wiki/File:Wikipedia-logo-v2.svg) | 161.552 KiB | 118.441 KiB | 118.441 KiB | | Before and after of the browser bundle of each respective version: | | v3.0.2 | v3.0.3 | Delta | |---|---|---|---| | svgo.browser.js | 643.5 kB | 651.7 kB | ⬆️ 8.2 kB | </details> --- ### Configuration 📅 **Schedule**: Branch creation - "on Monday after 10am before 7pm" in timezone Asia/Seoul, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/channel-io/bezier-react).  --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Ed Sungik Choi <[email protected]>

SethFalco force-pushed the issue-1733 branch 3 times, most recently from bbbb167 to cdc995a Compare September 19, 2023 21:02

This was referenced Sep 19, 2023

fix(reusePaths): reuse defs tag if exists and remove redundant nodes #1785

Merged

Call for new maintainer(s) #1320

Open

TrySound approved these changes Sep 22, 2023

View reviewed changes

SethFalco force-pushed the issue-1733 branch from cdc995a to 0c6f798 Compare September 23, 2023 09:12

fix(reusePaths): dont reuse id if referenced in href

251c05b

SethFalco force-pushed the issue-1733 branch from 0c6f798 to 251c05b Compare September 23, 2023 20:44

SethFalco merged commit bd750ce into svg:main Sep 23, 2023
5 checks passed

BrewTestBot mentioned this pull request Nov 9, 2023

svgo 3.0.3 Homebrew/homebrew-core#153720

Merged

gin-lsl mentioned this pull request Dec 21, 2023

Chrome icon color bug ant-design/ant-design-web3#310

Closed

X-oss-byte mentioned this pull request May 25, 2024

[Snyk] Upgrade svgo from 3.0.2 to 3.2.0 X-oss-byte/upgrading-ethereum-book#262

Open

snyk-io bot mentioned this pull request Jul 17, 2024

[Snyk] Upgrade svgo from 1.3.2 to 3.3.2 WontonSam/heroicons#10

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(reusePaths): dont reuse id if referenced in href #1784

fix(reusePaths): dont reuse id if referenced in href #1784

SethFalco commented Sep 18, 2023 •

edited

Loading

fix(reusePaths): dont reuse id if referenced in href #1784

fix(reusePaths): dont reuse id if referenced in href #1784

Conversation

SethFalco commented Sep 18, 2023 • edited Loading

Example

Related

Notes

SethFalco commented Sep 18, 2023 •

edited

Loading